home *** CD-ROM | disk | FTP | other *** search
/ By Popular Request 2.0 / By Popular Request 2.0 (Arsenal Computer).ISO / amiga_6 / tikmet12.lha / TickMet.doc < prev    next >
Text File  |  1994-12-10  |  9KB  |  327 lines
  1.  
  2. ************************************************************************
  3.  
  4.                                 TickMet
  5.  
  6.                                 (c) 1994
  7.  
  8.                              by Peter Deane
  9.  
  10.                               Version 1.2
  11.  
  12.                              Date 09-Dec-94
  13.  
  14.                       Written in GFA-BASIC V3.51E
  15.  
  16. ************************************************************************
  17.  
  18.  
  19. Description
  20. ~~~~~~~~~~~
  21.  
  22. TickMet is a small program written to add files to a Metro file listing
  23. from the command line.  It is envisaged the program will be run from a
  24. Tick program.  'Atick' by Russel Miranda and 'FoozleTick' by Peer
  25. Hasselmeyer are two programs the program has been tested with.
  26.  
  27. FoozleTick is particularly recommended because of its 4-D addressing
  28. abilities, and AKAs for different file areas.
  29.  
  30. TickMet will also keep a short list of the last XX files received via
  31. the Tick program, in reverse chronological order (most recent first),
  32. which can be run without the Metro 'FileList_X' file option, making it
  33. somewhat useful for any systems that use a Tick program.
  34.  
  35.  
  36. Update notes
  37. ~~~~~~~~~~~~
  38. V1.2  (09 Dec 94) few minor changes for public release for the OzMetro
  39.       package.  You can now keep a record of to the last 500 files
  40.       passing through your system.
  41.  
  42. V1.1  (30 Oct 94) Changed for the new OzMetro FileList_X files rather
  43.       than the old "df X" files.  No longer needs to update the hdf X
  44.       files either - they are no longer in existence!
  45.  
  46. (hmm, where are the changes between 0.85 and 1.1 ????)
  47.  
  48. V0.85 (16 Feb 92) Fixed a rather stupid bug where I was intentionally
  49.       chopping the last character of the description. It now only does
  50.       this if it's an ascii value less than 31.
  51.  
  52. V0.84 (13 Feb 92) First public release.
  53.  
  54.  
  55. Usage - from CLI
  56. ~~~~~
  57.  
  58. I suggest you copy the program into your c:  directory, or in a path
  59. otherwise in your search path.
  60.  
  61. You then may run the program from CLI:
  62.  
  63.     TickMet <name> <path> <area> <length> <desc>
  64.  
  65. where:
  66.  
  67. <name>   Filename of file to add to an area
  68. <path>   Directory for this file area (as in udfiles/file.areas)
  69. <area>   The ADS/Tick File area TagName
  70. <length> Size of the file
  71. <desc>   Description, which will be truncated to 76 characters.
  72.  
  73.  
  74. NO INVERTED COMMAS SHOULD BE USED IN THE COMMAND LINE!
  75.  
  76. By the same token, no spaces are allowed in any parameter, except for
  77. the description (where there can be as many as you like).
  78.  
  79.  
  80. For example:
  81.  
  82.   TickMet  TICKMET082.LHA DH4:METRO/ METROUTES 99999 This very program!
  83.  
  84. Would add the file to a metro file areaname which had a directory
  85. specified as 'DH4:Metro/'
  86.  
  87. (Incidentally, in this program, it's optional to include a trailing
  88. slash after the pathname. If the pathname does not end in either ':' or
  89. '/', then a trailing '/' will be appended. It figures that if you need
  90. the directory to be a volume name (eg DF0:, BBS:) then you must include
  91. the colon ':'.)
  92.  
  93.  
  94. Use from the CLI would only be for the masochist, though, but has been
  95. handy if you know what you're doing.
  96.  
  97.  
  98. Usage - from Tick.cfg
  99. ~~~~~
  100.  
  101. Add a line to your Tick.cfg that says:
  102.  
  103.    EXECUTE "TickMet %n %p %a %l %d"
  104.  
  105. That's all! Feeling better now?
  106.  
  107.  
  108. What it does
  109. ~~~~~~~~~~~~
  110.  
  111. The program reads in the filename and directory name given to it by the
  112. tick program. The most important piece of information is the directory
  113. name the file is destined for.
  114.  
  115. If the directory name should match anything listed in your
  116. UDFILES/File.areas file, it will be added to the file listings for that
  117. directory.
  118.  
  119. EG say your Tick.cfg had these file areas:
  120.  
  121.  
  122. FILEECHO FIDONEWS DF0:Fidonews/
  123. TO 3:622/490 *
  124. TO 3:622/491.1 HNX 
  125. TO 3:622/491.2 HNX
  126. TO 3:622/491.3 HNX
  127.  
  128. FILEECHO BBSLIST DH4:visitor/
  129. TO 3:622/490 *
  130. TO 3:622/491.1 HNX
  131. TO 3:622/491.2 HNX
  132. TO 3:622/491.3 HNX
  133.  
  134. Then you should have the corresponding directories in file.areas:
  135.  
  136. 1
  137. 1
  138. 7
  139. 7 - OTHER Fido News
  140. DF0:FidoNews/
  141. 1
  142. 1
  143. 9
  144. 9 - INQUESTOR BBS Files
  145. DH4:Visitor/
  146.  
  147.  
  148. If any file is ticked in bound for DF0:FidoNews/, say, then an entry in
  149. the file area '7 - OTHER Fido News' will be added!
  150.  
  151. You just have to play around with the directory names so they match up
  152. in your file areas, and your Tick.cfg file (a necessary evil in any
  153. case!). The matching of directory names is not case sensitive at all.
  154.  
  155. One word of warning, if two file areas should share the same directory,
  156. then TickMet will add the file to the first match in file.areas it
  157. finds.  This practice (sharing one file directory among many areas) is
  158. inconvenient in practice anyway.
  159.  
  160. Another word of warning: make sure the device names match up.  If you
  161. have MAIL: assigned to DH8: (like I do) then make sure you use the SAME
  162. device name in both Tick.cfg and the File.areas file.  It doesn't matter
  163. which, but for TickMet to find the area the device name Tick tells it
  164. has to be found in the File.areas file.  If not, then it won't add it to
  165. a file area.
  166.  
  167.  
  168. Config File
  169. ~~~~~~~~~~~
  170.  
  171. TickMet will run fine without a config file to add the files into your
  172. Metro BBS file listings.  However, it also has a second function:  to
  173. keep a record of the most recent files that were ticked in.
  174.  
  175. Having a file called 'TickMet.cfg' in your MAIL: directory will enable
  176. this feature.
  177.  
  178. The config file is a real simple one - two lines only! I was
  179. disappointed about having to use a config, but due to the fact the
  180. command line is basically out, I reluctantly decided the config was a
  181. necessary evil.
  182.  
  183. The format of the config is:
  184.  
  185. line 1  Number of files
  186. line 2  Name of output file
  187.  
  188. As in:
  189.  
  190. 50
  191. BBS:TickList
  192.  
  193. would keep a list of the last 50 files received via TickMet in the file
  194. 'BBS:TickList'
  195.  
  196. It's also imperative to add a carriage return or two after typing the
  197. second line.
  198.  
  199. I recommend you actually use an OzMetro textfile (eg BBS:Textfiles1/Text503
  200. as the output file because you can then have the info displayed on the
  201. BBS from some textfile command.
  202.  
  203. The list TickMet produces is very simple but is quickly sent to a BBS
  204. user's screen. This was intentional! It looks like this:
  205.  
  206. ----
  207. File: 17.FILE
  208. Size: 9999 
  209. Date: 13-Feb-92
  210. Area: FUNNY-NAME 
  211. Desc: Here starts the description for this file. Here it ends..
  212. ----
  213. File: 16.FILE
  214. Size: 9999 
  215. Date: 13-Feb-92
  216. Area: FUNNY-NAME 
  217. Desc: Here starts the description for this file. Here it ends..
  218. ----
  219. File: 15.FILE
  220. Size: 9999 
  221. Date: 13-Feb-92
  222. Area: FUNNY-NAME 
  223. Desc: Here starts the description for this file. Here it ends..
  224. ----
  225. File: 14.FILE
  226. Size: 9999 
  227. Date: 13-Feb-92
  228. Area: FUNNY-NAME 
  229. Desc: Here starts the description for this file. Here it ends..
  230.  
  231.  
  232. If you ever need to adjust the number of files you keep record of, then
  233. just change the number in the config.  The old file will be adjusted to
  234. the new format automatically, the next time the program is run.
  235.  
  236. You can keep the records of up to the last 500 files added by TickMet.
  237. Any larger amount (or smaller than 1) of records will simply result in
  238. this part of the program being by-passed.
  239.  
  240.  
  241. Command Line Errors
  242. ~~~~~~~~~~~~~~~~~~~
  243.  
  244. Things can go wrong while TickMet is being run:
  245.  
  246. * Command line missing or truncated.
  247.  
  248. Basically, this indicates there was no command line given, so we give up
  249. now.
  250.  
  251. * Insufficient arguments.
  252.  
  253. Didn't get enough info from the command line.  Can't carry on.
  254.  
  255. In these two cases the usage details are output, and execution ceases.
  256.  
  257.  
  258. Metro Errors
  259. ~~~~~~~~~~~~
  260.  
  261. * Udfiles/File.areas not found.
  262.  
  263. * Number of items in 'file.areas' not a multiple of 5.
  264.  
  265. These two are pretty self-explanatory.  The Metro file config wasn't
  266. found, or was in the incorrect format (Metro wouldn't run in either of
  267. these cases as well!).  Execution jumps to the next stage without making
  268. an addition to a file list anywhere!
  269.  
  270. * No area found for this file.
  271.  
  272. We couldn't find a match for the directory name in file.areas.
  273. Execution ceases at this point, and no attempt is made to update the
  274. Last 'XX' files list.
  275.  
  276. * Over 495 files already in this area!
  277.  
  278. Metro has a 500 file limit per area.  I err on the side of safety here.
  279. The file will not be added to the Metro file list, but maybe the Last XX
  280. Files list can be updated.
  281.  
  282.  
  283. Output File Errors
  284. ~~~~~~~~~~~~~~~~~~
  285.  
  286. The file is self-maintaining, and if it doesn't exist, it will be
  287. created.  One thing I don't check for is an invalid filename, so please
  288. ensure that the path can be set to it, and it's not a device, directory
  289. or something equally as silly.
  290.  
  291. I imagine a very definite name will be used to get the textfile
  292. displayable on your BBS.  Such as 'BUL:Bulletin1.txt' or
  293. 'BBS:Textfiles1/Text_534' and what-have-you.  Anything is permissable as
  294. far as the program is concerned.  It would be nice if DOS liked it too!
  295.  
  296.  
  297.  
  298. Distribution
  299. ~~~~~~~~~~~~
  300. The program is NOT in the public domain.  A license is granted to all
  301. persons to copy the file as much as possible provided no profit is made
  302. from distribution.
  303.  
  304. Bug reports MUST be forwarded at the earliest opportunity.
  305.  
  306. Source in GFA is included, however no person may distribute modified
  307. copies of this program.  Any mod you make is for your OWN use only!
  308.  
  309.  
  310. Contact
  311. ~~~~~~~
  312.  
  313. For questions, donations, bug reports, comments, etc...
  314.  
  315. Peter Deane
  316.  
  317. FidoNet:   3:622/401        Postal: PO Box 228
  318. GlobalNet: 54:6101/401              Swansea  NSW  2281
  319. AmigaNet:  41:200/401               AUSTRALIA
  320.  
  321. Internet: peter.deane@p0.f401.n622.z3.fido.zeta.org.au
  322.           (okay, I cheated, but the gate works really well)
  323.  
  324. BBS:    from O/S   +61-49-72-1647
  325. (24hrs) from Aust  (049) 72-1647
  326.  
  327.